/**
 * Copyright (c) 2011 eelpo.com
 * All rights reserved.
 */
package com.eelpo.cmmp.uac.services;

import javax.swing.tree.DefaultTreeModel;

import com.eelpo.cmmp.core.exception.ServiceException;
import com.eelpo.cmmp.uac.dao.vo.Entity;

/**
 * <pre>
 * 业务实体服务管理接口定义
 * </pre>
 * 
 * @author <a href="mailto:Brian@eelpo.com">汪洪州</a>
 * @since 1.0
 */
public interface IEntityManageService {

	/**
	 * 根据业务实体Id获取业务实体对象
	 * 
	 * @param id
	 *            业务实体ID
	 * @return 返回业务实体值对象
	 * @throws ServiceException
	 *             抛出服务层业务异常
	 */
	public Entity getEntityById(String id) throws ServiceException;

	/**
	 * 根据业务实体获取业务实体对象
	 * 
	 * @param code
	 *            业务实体code值
	 * @return 返回业务实体值对象
	 * @throws ServiceException
	 *             抛出服务层业务异常
	 */
	public Entity getEntityByCode(String code) throws ServiceException;

	/**
	 * 检查业务实体是否已经存在
	 * 
	 * @param code
	 *            业务实体code值
	 * @return 返回布尔值，true表示已经存在，false表示不存在
	 * @throws ServiceException
	 *             抛出服务层业务异常
	 */
	public boolean checkExist(String code) throws ServiceException;

	/**
	 * 新增业务实体
	 * 
	 * @param entity
	 *            业务实体对象
	 * @return 返回新增过的业务实体ID
	 * @throws ServiceException
	 *             抛出服务层业务异常
	 */
	public String addEntity(Entity entity) throws ServiceException;

	/**
	 * 修改业务实体
	 * 
	 * @param entity
	 *            业务实体对象
	 * @throws ServiceException
	 *             抛出服务层业务异常
	 */
	public void updateEntity(Entity entity) throws ServiceException;

	/**
	 * 根据Id删除业务实体
	 * 
	 * @param entity
	 *            业务实体对象
	 * @throws ServiceException
	 *             抛出服务层业务异常
	 */
	public void deleteEntity(Entity entity) throws ServiceException;

	/**
	 * 获取用户有权限操作的所有启用菜单实体
	 * 
	 * @param userId
	 *            用户ID
	 * @return 用户有权限操作的所有启用菜单实体
	 * @throws ServiceException
	 *             抛出服务层业务异常
	 */
	public DefaultTreeModel getMenuEntities(String userId) throws ServiceException;
}
